home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / Kubuntu 8.10 / kubuntu-8.10-desktop-i386.iso / casper / filesystem.squashfs / usr / share / doc / libxplc0.3.13 / README < prev    next >
Text File  |  2005-10-31  |  3KB  |  103 lines
  1. XPLC (Cross-Platform Lightweight Components)
  2. ============================================
  3.  
  4. Release: 0.3.13
  5. Web Site: http://xplc.sourceforge.net/
  6. Maintainer: Pierre Phaneuf <pp@ludusdesign.com>
  7.  
  8. Introduction
  9. ------------
  10.  
  11. XPLC (cross-platform lightweight components) is a component system
  12. that provide extensibility and reusability both inside and between
  13. applications, being portable across platforms and languages, easy to
  14. use and having the lowest possible overhead.
  15.  
  16. Stability/Usability
  17. -------------------
  18.  
  19. XPLC is quickly becoming usable, but it's API is still in a state of
  20. flux. A project that would like to use XPLC would thus have to either
  21. require a precise version or link it statically. They should also be
  22. prepared to follow changes in the API as they change from one version
  23. of XPLC to the other.
  24.  
  25. That said, using XPLC should now be possible, provided that you are
  26. subscribed to the mailing list and know what you are doing.
  27.  
  28. Documentation
  29. -------------
  30.  
  31. The documentation for XPLC is available online:
  32.  
  33.            http://xplc.sourceforge.net/doc/
  34.  
  35. Thanks
  36. ------
  37.  
  38. I would like to thank Net Integration Technologies, my employers, for
  39. allowing me to work on XPLC a day a week and generally being a cool
  40. place to work at.
  41.  
  42. License
  43. -------
  44.  
  45. All files included in this package are covered by the Lesser General
  46. Public License, unless noted otherwise. Refer to the 'LICENSE' file
  47. for terms and conditions.
  48.  
  49. Releases
  50. --------
  51.  
  52. XPLC uses a numbering scheme for releases similar to what the Linux
  53. kernel uses. In short, a release number is composed of three parts,
  54. the major, minor and patchlevel numbers (like this: 3.4.31).
  55.  
  56. The minor number has a special signification depending on whether it
  57. is even or odd. If it is even, it means that this is a stable release,
  58. suitable for use in a production environment. If it is odd, it means
  59. that this is a development release, intended for people willing to
  60. test XPLC, report bugs and/or work on its development.
  61.  
  62. Installation
  63. ------------
  64.  
  65. See the 'INSTALL' file.
  66.  
  67. Patches
  68. -------
  69.  
  70. Patches should preferably be submitted to the patch tracking system on
  71. our SourceForge project page (http://sourceforge.net/projects/xplc/),
  72. but could also be send via e-mail to the maintainer.
  73.  
  74.                           *** IMPORTANT ***
  75.                    
  76. Before preparing a patch, you should make sure that 'make tests'
  77. passes all tests. Those tests are made to be as easy to use as
  78. possible, so please use them. Using the "--enable-fatal-warnings"
  79. option of the "configure" script is also recommended.
  80.  
  81. The simpler way to prepare a patch requires CVS and Internet
  82. access. Just issue the following command in the root XPLC project
  83. directory:
  84.  
  85. $ cvs diff -u > mypatch.diff
  86.  
  87. You can also send a patch that is limited to a few files in the
  88. following way:
  89.  
  90. $ cvs diff -u [FILES] > mypatch.diff
  91.  
  92. If you do not have CVS and/or Internet access, you should do the
  93. following:
  94.  
  95.  - rename the XPLC source directory to something like 'xplc-modified'
  96.  - unpack the fresh XPLC sources
  97.  - run the following command:
  98.  
  99. $ diff -ruN xplc-X.Y.Z xplc-modified > mypatch.diff
  100.  
  101. You can then submit the mypatch.diff file for inclusion in XPLC!
  102.  
  103.